Update customer

Update a customer by id. Only some fields can be updated using these API.

PATCH /customers/{id}

cURL

cURL

curl --request PATCH \
  --url https://app.masivo.ai/api/storefront/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Smith",
  "platforms": [
    "<string>"
  ],
  "dob": "2023-11-07T05:31:56Z",
  "document_type": "<string>",
  "document_number": "<string>",
  "country": "<string>",
  "phone": "[phone]",
  "tags": {},
  "metadata": {}
}
'

200

{
  "data": {
    "customer": {
      "id": "<string>",
      "name": "John Smith",
      "email": "[e-mail]",
      "registration_date": "2023-11-07T05:31:56Z",
      "is_anonymous": false,
      "dob": "2023-11-07T05:31:56Z",
      "document_type": "<string>",
      "document_number": "<string>",
      "country": "<string>",
      "phone": "[phone]",
      "phone_verified": false,
      "tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tags": {},
      "consent": {
        "consent_string": "COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA",
        "version": "2.0",
        "consent_timestamp": "2023-11-07T05:31:56Z",
        "customer_id": "<string>",
        "purposes": {
          "behavioral_campaigns": true,
          "coupon_campaigns": true,
          "punchcard_campaigns": true,
          "email_marketing": true,
          "push_notifications": true,
          "link_tracking": true
        },
        "vendors": {
          "vendor_123": true,
          "vendor_456": false
        }
      },
      "metrics": {},
      "metadata": {}
    },
    "wallet": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lines": [
        {
          "amount": 123,
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "issued_at": "2023-11-07T05:31:56Z",
          "expiration_date": "2023-11-07T05:31:56Z",
          "reservation_expires_at": "2023-11-07T05:31:56Z"
        }
      ],
      "totals": [
        {
          "total": 127.6,
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "expiration_date": "2023-11-07T05:31:56Z",
          "reward": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "brand_id": "<string>",
            "platforms": [
              "<string>"
            ],
            "name": "<string>",
            "description": "<string>",
            "conditions": [
              [
                {
                  "type": "Order Value",
                  "operator": "grater than",
                  "value": 9.95
                }
              ]
            ],
            "attributes": {
              "conversion_factor": 0.1
            }
          }
        }
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The customer unique identifier in your system

Body

application/json

name · string

The full name of the customer

Example:

"John Smith"

platforms · string[] | null

Platforms associated with the customer

gender · enum<string>

The gender of the customer. Can only be updated if not set.

Available options: MALE, FEMALE

dob · string<date-time> | null

The date of birth of the customer. Can only be updated if not set.

document_type · string | null

The document type of the customer. If provided, document_number is required.

document_number · string | null

The document number of the customer. If provided, document_type is required.

Maximum string length: 50

country · string | null

The country of the customer

Maximum string length: 100

phone · string | null

The customer's phone number in international format. Required for WhatsApp delivery.

Example:

"[phone]"

tags · object

Include your conditions customer tags here

metadata · object

The metadata of the customer

Response

200

application/json

Customer updated

data · object

Show child attributes